/****************************************************************************
**
** Copyright (C) 2010 Tieto Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Tieto Corporation (info.ostrava@tieto.com)
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Tieto.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Tieto gives you certain additional
** rights.  These rights are described in the Tieto Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Tieto at info.ostrava@tieto.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef ETALONMODEL_H
#define ETALONMODEL_H

#include "featuremodel.h"

/**
 * Etalon model
 */
class EtalonModel : public FeatureModel
{

Q_OBJECT

public:

    /**
     * Etalon features
     */
    enum FeatureID {
        EName,          // name
        EImage,         // image
        ETODO,          // TODO
        ETODOrange      // TODO range
    };

    /**
     * Constructor
     */
    explicit EtalonModel(QObject *parent = 0);

    /**
     * Resets model
     */
    void reset();

    /**
     * Add new etalon
     */
    void addEtalon();

    /**
     * Removes etalon
     * @row etalon row
     */
    void removeEtalon(const int row);

    /**
     * Update etalon
     * @param name etalon name
     * @param feature etalon feature
     */
    void updateEtalon(const QString &name, const Feature &feature);

    /**
     * Recognizes features
     * @param features recognizing features
     * @return recognized etalon name, otherwise empty string
     */
    QString recognize(const Features &features);

    /**
     * Gets etalon names
     * @return etalon names
     */
    QStringList etalonNames();

    // From QAbstractItemModel

    Qt::ItemFlags flags(const QModelIndex &index) const;

signals:

public slots:   

private:

    /**
     * Etalons id
     */
    int etalonId;

    /**
     * Recognizes etalon
     * @param row etalon row
     * @param features recognizing features
     * @return true, if etalon was recognized
     */
    bool recognizeEtalonFeatures(const int row, const Features &features);

    /**
     * Recognizes etalon feature
     * @param row etalon row
     * @param feature recognizing feature
     * @return true, if etalon was recognized
     */
    bool recognizeEtalonFeature(const int row, const Feature &feature);

};

#endif // ETALONMODEL_H
